<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="IHistoryManagerClient,mx.managers.IHistoryManagerClient,loadState,saveState,toString" name="keywords">
<title>mx.managers.IHistoryManagerClient</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IHistoryManagerClient - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/managers/IHistoryManagerClient.html&amp;mx/managers/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;IHistoryManagerClient</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IHistoryManagerClient"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.managers</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IHistoryManagerClient</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implementors</td><td><a href="../containers/Accordion.html">Accordion</a>, <a href="../containers/ViewStack.html">ViewStack</a></td>
</tr>
</table>
<p></p>
  Interface that must be implemented by objects
  registered with the History Manager. The methods in this interface are
  called by the HistoryManager when saving and loading the history state
  of the application.
   <p>This interface is implemented by the Flex navigator containers 
  TabNavigator, Accordion, and ViewStack. It must be implemented by any other
  component that is registered with the HistoryManager.</p> 
   <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../managers/HistoryManager.html" target="">mx.managers.HistoryManager</a>
</div>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#loadState()">loadState</a>(state:Object):void</div>
<div class="summaryTableDescription">
   Loads the state of this object.</div>
</td><td class="summaryTableOwnerCol">IHistoryManagerClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#saveState()">saveState</a>():Object</div>
<div class="summaryTableDescription">
   Saves the state of this object.</div>
</td><td class="summaryTableOwnerCol">IHistoryManagerClient</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#toString()">toString</a>():String</div>
<div class="summaryTableDescription">
   Converts this object to a unique string.</div>
</td><td class="summaryTableOwnerCol">IHistoryManagerClient</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="loadState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">loadState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function loadState(state:Object):void</code><p>
   Loads the state of this object.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">state</span>:Object</code> &mdash; State of this object to load.
   This will be null when loading the initial state of the application.
     </td>
</tr>
</table>
<br>
<span class="label">Example</span>
<br>The following code loads the selected index and search string
   from the saved state.
   <pre>
   public function loadState(state:Object):void
   {
    // First, check to see if state is null. When the app is reset
    // back to its initial state, loadState() is passed null.
    if (state == null)
    {
    myList.selectedIndex = -1;
     mySearchInput.text = "";
    }
    else
    {
     myList.selectedIndex = state.selectedIndex;
     mySearchInput.text = state.searchString;
    }
   }
   </pre>
  <p></p>
</div>
<a name="saveState()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">saveState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function saveState():Object</code><p>
   Saves the state of this object. 
   The object contains name:value pairs for each property
   to be saved with the state. 
     </p><p>The History Manager collects the state information from all components
   and encodes the information in a URL format. Most browsers have a length
   limitation on URLs, so the state information returned should be as minimal
   as possible.</p>
     <p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Object</code> &mdash; The state of this object.
  </td>
</tr>
</table>
<br>
<span class="label">Example</span>
<br>The following code saves the selected index from a List, and
   a search string.
   <pre>
   public function saveState():Object
   {
    var state:Object = {};
      state.selectedIndex = myList.selectedIndex;
    state.searchString = mySearchInput.text;
      return state;
  }
  </pre>
     <p></p>
</div>
<a name="toString()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function toString():String</code><p>
   Converts this object to a unique string. 
   Implemented by UIComponent.
     </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; The unique identifier for this object.
  </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
